home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / txtedtrs / tx2cnvt2 / tx2codes.doc < prev   
Text File  |  1995-05-02  |  8KB  |  209 lines
  1. ABOUT THE TX2 FORMAT
  2.  
  3. This file will describe the complete TX2 format.  You can read this
  4. just out of curiousity, or if you want to add TX2 support to your
  5. programs.
  6.  
  7. All new TX2 files should be level 4.  Levels 2 and 3 were used in the
  8. old shareware version of the TX2 File Viewer.  Following are the codes
  9. for level 4 files, followed by the changes that were made from levels
  10. 2 and 3.
  11.  
  12. The codes will be listed as hex, preceded with a dolar sign.
  13.  
  14. Every TX2 file starts with a header.  The first byte must be $14.  The
  15. second byte indicates the level of the file.  Level 4 files use $04.
  16. This is followed by a carriage return and line feed ($0D0A), as every
  17. line should.
  18.  
  19. Evey line which contains any TX2 code must start with a null ($00).
  20. If not present, the program will ignore any codes that might appear on
  21. that line.
  22.  
  23.     $01    Color 1 (not used very often)
  24.     $02    Color 2
  25.     $03    Color 3
  26.     $04    Bold
  27.     $05    Light
  28.     $06    Italics
  29.     $14    Double Size
  30.     $1402  Half Size
  31.     $16    Underline
  32.     $1E    Outline
  33.  
  34. Each of the above is a toggle.  The first time it apears will turn it
  35. on; the next time will turn it off.
  36.  
  37. Note: If the code for italics ($06) comes before an underline
  38. character, the "_" will not be printed.  This is because most people
  39. use this character to represent italics when in plain text mode.
  40.  
  41. A very important code is $10.  This signifies that there are no more
  42. codes on the line, so the program can blit the rest of it very
  43. quickly.  This also turns off all of the special effects except
  44. different colors.  (Note: the TX2 Editor does not use this code.)
  45.  
  46. $0F is the ignore code.  If found, the program will ignore the rest of
  47. the text on the line, and not print it.
  48.  
  49. $1102, $1103, $1104, $2002, $2003, and $2004 are codes reserved for
  50. GEnie Lamp magazine.  They are for the titles and Quick_Quotes that
  51. appear within this online magzine.
  52.  
  53. $12 is for a divider.  It was designed for GEnie Lamp, but can be used
  54. elsewhere.  It is a small design (about 50 pixels wide) meant to
  55. separate sections.  It also signifies the end of a line.
  56.  
  57. $13 is for a line.  It is a thick (shadowed in color) line meant to be
  58. used in place of "------------", etc.  The first $13 indicates the
  59. start of the line; the second is for the end.  Make sure that you end
  60. the line before the next carriage return; otherwise, you can create
  61. problems.
  62.  
  63. $1C if for a full external picture.  It is followed by the number of
  64. the picture to be displayed, using the translation table (see below).
  65. In the text, the program will create a small [** PICTURE **] icon.  By
  66. pressing [P], the picture will be called up.  (See the section on the
  67. index below for more information.)
  68.  
  69. $17 is for an integrated picture.  This is followed by the number of
  70. the picture to be used, using the translation table.  The next code is
  71. the line of the picture to be displayed, also using the translation
  72. table.
  73.  
  74. That's it for the codes.  The translation table is used to number
  75. items without using displayable codes.  They are as follows:
  76.  
  77.     1    $02
  78.     2    $03
  79.     3    $04
  80.     4    $05
  81.     5    $06
  82.     6    $0E
  83.     7    $0F
  84.     8    $10
  85.     9    $11
  86.     10   $12
  87.     11   $13
  88.     12   $14
  89.     13   $16
  90.  
  91. The program only allows for up to 13 of each type of picture.
  92. However, integrated pictures can use more than 13 lines.  For numbers
  93. beyond 13, they use $17 plus the table all over again.  Simply add the
  94. 13 to the next code.  For example, $1706 is the code for line #18.
  95.  
  96. These are all of the codes that would appear within a TX2 file.  There
  97. is also a separate index file, which has the same filename, except
  98. with the ".IDX" extension.  If contains a list of sections, plus
  99. filenames of pictures to be added to the text.
  100.  
  101. If there are no pictures, the first line only contains the number of
  102. items in the index.  Then, each following line contains the section
  103. name, enclosed in quotation marks (". . ."), followed by a comma,
  104. followed by the line on which the section starts in the file.
  105.  
  106. If there are pictures, then it is a little more complicated.  The
  107. first line must contain the string, "PICS", no quotes.  The next line
  108. contains four numbers, separated by commas.  They are number of
  109. external pictures, number of integrated pictures, number of clipped
  110. DEGAS pictures, and the last one is reserved for future use.  Then,
  111. list the filenames of all of the pictures.
  112.  
  113. External pictures are full-sized NEO or DEGAS (compressed or
  114. uncompressed) pictures.  List these first, if there are any.  If there
  115. is more than one picture for different resolutions, use "x" and "y"
  116. (note lowercase) in place of the "1," "2," or "3."  An "x" means that
  117. there is a picture for medium and high resolution.  A "y" means that
  118. there is a picture for low and high resolution.  (see example at end
  119. of section.)
  120.  
  121. Integrated pictures are those stored in the GFA BASIC PUT format.
  122. These take the extension "PTM" for medium resoltion, and "PTH" for
  123. high resolution.  You can also use the "x" to indicate that a picture
  124. is available in more than one resolution.
  125.  
  126. Clipped DEGAS pictures aren't used much, but they are useful for
  127. compressing integrated pictures.  List the filename, followed by the
  128. width and length of the area to be clipped.  (The picture must start
  129. at the 0,0 coordinate.)  For example, "PICTURE.PCx,100,50".
  130.  
  131. Here is an example of an actual index file taken from issue #2.23 of
  132. GEnie Lamp magazine.  (Comments as shown cannot be included.)
  133.  
  134. PICS          ; required string
  135. 8,5,0,0       ; there are eight full pics and five integrated ones
  136. MODEM2.PIy    ; this picture works in high and low resolutions
  137. MODEM3.PIy
  138. FIGURE1.PI3   ; this picture only works in high resolution
  139. FIGURE2.PI3
  140. FIGURE3.PI3
  141. FIGURE4.PI3
  142. FIGURE5.PI3
  143. FIGURE6.PI3
  144. GELMP.PTx     ; this integrated picture works in high and medium
  145. resolutions
  146. LGSMAIN.PTx
  147. LGSPATH.PTx
  148. LGSINFO.PTx
  149. TECHNOL.PTx
  150. 17            ; there are seventeen sections
  151. "TOP",2       ; name of sections is in quotes, followed by the staring
  152. line
  153. "FROM MY DESKTOP",93    ; note: 2 should be added to any starting
  154. line
  155. "SYSOP'S CORNER",182
  156. "HEY MISTER POSTMAN",331
  157. "HUMOR ONLINE",928
  158. "DEALER VIEWPOINT",1045
  159. "MEL'S MANOR",1222
  160. "ATARI_QWIK_TIPS ",1452
  161. "PD_QUICKVIEW ST",1555
  162. "THE ONLINE LIBRARY",1672
  163. "TELETALK ONLINE",1929
  164. "ST ALADDIN ONLINE",2062
  165. "GEnie Online",2314
  166. "HACK'N ATARI",2592
  167. "OFF THE RECORD",2906
  168. "ST ELSEWHERE",2990
  169. "LOG OFF",3067
  170.  
  171. If you have any questions on anything mentioned in this file, please
  172. let me know at "David Holmes, 13124 Rose Ave., Los Angeles, CA
  173. 90066-2223".  Or, send E-Mail on GEnie to [D.HOLMES14].  I am willing
  174. to work with you to get TX2 supported in other programs.
  175.  
  176. ABOUT LEVEL 2 AND 3 FILES
  177.  
  178. Level 2 and 3 files had a few differences.  First, level two files
  179. started with $1402, and level three files started with $140303.  The
  180. two are identical in every way except that level three files support
  181. an index, while level two files don't.
  182.  
  183. In these files, lines with codes either started with $00 or
  184. $0000+another code.  The double null signified to search for the
  185. following character.  For example,
  186.  
  187. $00 $00 $06 This is a test of $06_italics$06_$10...
  188.  
  189. This was replaced in level four files by an automatic search feature.
  190.  
  191. Also, "lines" starting with $13 did not end with another $13, but
  192. rather a space, $20.
  193.  
  194. Underline was $07 (but this rang the system bell).  Integrated
  195. pictures used $1F.  Quick_Quotes used $20, $22, and $23.
  196.  
  197. The translation table used $0C for six, and everything else was moved
  198. up one.  $14 followed by another would be 14 plus the other.
  199.  
  200. ----------
  201. Note: This format is in the public domain.  Anyone may write a program
  202. which supports TX2 files to any extent without my permission.
  203. However, I would appreciate it if you would let me know.  I am also
  204. available if you need any help understanding how it works.
  205. ----------
  206.  
  207. Copyright (c) 1991 David Holmes
  208. GEnie: D.HOLMES14
  209.